Query

A query to retrieve information from the syntax tree.

struct Query {

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

import libc : ts_query_new, ts_query_delete, ts_query_pattern_count, ts_query_capture_count, ts_query_start_byte_for_pattern, ts_query_predicates_for_pattern, ts_query_step_is_definite, ts_query_capture_name_for_id, ts_query_disable_capture, ts_query_disable_pattern, ts_query_string_count, ts_query_string_value_for_id;;

TSQuery* tsquery;

this(Language language, string queryString);

QueryIterator exec(Node node);

QueryIterator exec(Node node, uint min, uint max);

QueryIterator exec(Node node, Point min, Point max);

int pattern_count();

int capture_count();

int string_count();

int start_byte_for_pattern(uint patternId);

const(TSQueryPredicateStep)[] predicates_for_pattern(uint patternId);

bool step_is_definite(uint byteOffset);

string capture_name_for_id(uint captureId);

string capture_name(TSQueryCapture capture);

string query_string_value_for_id(uint id);

void disable_capture(string captureName);

void disable_pattern(uint patternId);

}

Constructors

this this(Language language, string queryString): Create a new query from a string containing one or more S-expression patterns.

Destructor

~this ~this(): Undocumented in source.

Postblit

this(this) this(this): Undocumented in source.

Members

Functions

capture_count int capture_count(): Get the number of captures in the query.
capture_name string capture_name(TSQueryCapture capture): Get the name of one of the query's captures, given a TSQueryCapture.
capture_name_for_id string capture_name_for_id(uint captureId): Get the name of one of the query's captures.
disable_capture void disable_capture(string captureName): Disable a certain capture within a query.
disable_pattern void disable_pattern(uint patternId): Disable a certain pattern within a query.
exec QueryIterator exec(Node node): Execute a query over an entire node.
exec QueryIterator exec(Node node, uint min, uint max): Execute a query between given start and end byte offsets.
exec QueryIterator exec(Node node, Point min, Point max): Execute a query between given start and end Points.
pattern_count int pattern_count(): Get the number of patterns in the query.
predicates_for_pattern const(TSQueryPredicateStep)[] predicates_for_pattern(uint patternId): Get all of the predicates for the given pattern in the query.
query_string_value_for_id string query_string_value_for_id(uint id): Get the name of one of the query's string literals.
start_byte_for_pattern int start_byte_for_pattern(uint patternId): Get the byte offset where the given pattern starts in the query's source.
step_is_definite bool step_is_definite(uint byteOffset): Check if a given step in a query is 'definite'.
string_count int string_count(): Get the number of string literals in the query.

Variables

tsquery TSQuery* tsquery;: The underlying TSQuery

Meta

Source

See Implementation

query classes

QueryException

structs